docs: rewrite CONTRIBUTING to reflect published, active project#28
Open
dmchaledev wants to merge 1 commit into
Open
docs: rewrite CONTRIBUTING to reflect published, active project#28dmchaledev wants to merge 1 commit into
dmchaledev wants to merge 1 commit into
Conversation
CONTRIBUTING.md stated the package was "in incubation", "not yet open for external contributions", and asked readers to "check back after the package is published to npm". All three are inaccurate: @hailbytes/sbom-diff is published on npm (v1.0.1 is the latest dist-tag) and is actively taking contributions (multiple PRs merged; many open). The stale notice actively discouraged the contributions the project is soliciting. Replace it with an accurate contributor guide: dev setup, the real npm scripts (test/lint/typecheck/build), the CI checks, Conventional Commit style matching the existing history, and PR guidelines. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_015FXrgnfVQVMvwjMtsaZqvL
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
CONTRIBUTING.mdcurrently turns away the very contributions this project is soliciting. It states the package is "in incubation", "not yet open for external contributions", and asks readers to "check back after the package is published to npm."All three claims are inaccurate:
@hailbytes/sbom-diffresolves on the npm registry with1.0.1as thelatestdist-tag (the README badges advertise the same).1.xrelease line is live.The result is a contributor guide whose only message is "go away, come back later" — a direct conversion-killer for an open-source security tool that, per the README, is "Part of the HailBytes open-source security toolkit."
Change
Replace the stale notice with an accurate, useful contributor guide:
npm install, Node>=18perengines)test,test:watch,test:coverage,lint,typecheck,build,cli)main(lint+test+build)fix(cli): ...,feat(diff): ...,docs: ...)Why this is high-leverage and low-risk
src/or the release workflows; this only touchesCONTRIBUTING.md.🤖 Generated with Claude Code
Generated by Claude Code